<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements.  See the NOTICE file distributed with</a>
<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
<span class="sourceLineNo">007</span><a id="line.7"> * the License.  You may obtain a copy of the License at</a>
<span class="sourceLineNo">008</span><a id="line.8"> *</a>
<span class="sourceLineNo">009</span><a id="line.9"> *      http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
<span class="sourceLineNo">016</span><a id="line.16"> */</a>
<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.dbutils.handlers;</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import java.sql.ResultSet;</a>
<span class="sourceLineNo">020</span><a id="line.20">import java.sql.SQLException;</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.commons.dbutils.RowProcessor;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * &lt;p&gt;</a>
<span class="sourceLineNo">026</span><a id="line.26"> * {@code ResultSetHandler} implementation that returns a Map of Beans.</a>
<span class="sourceLineNo">027</span><a id="line.27"> * {@code ResultSet} rows are converted into Beans which are then stored in</a>
<span class="sourceLineNo">028</span><a id="line.28"> * a Map under the given key.</a>
<span class="sourceLineNo">029</span><a id="line.29"> * &lt;/p&gt;</a>
<span class="sourceLineNo">030</span><a id="line.30"> * &lt;p&gt;</a>
<span class="sourceLineNo">031</span><a id="line.31"> * If you had a Person table with a primary key column called ID, you could</a>
<span class="sourceLineNo">032</span><a id="line.32"> * retrieve rows from the table like this:</a>
<span class="sourceLineNo">033</span><a id="line.33"> *</a>
<span class="sourceLineNo">034</span><a id="line.34"> * &lt;pre&gt;</a>
<span class="sourceLineNo">035</span><a id="line.35"> * ResultSetHandler&amp;lt;Map&amp;lt;Long, Person&amp;gt;&amp;gt; h = new BeanMapHandler&amp;lt;Long, Person&amp;gt;(Person.class, &amp;quot;id&amp;quot;);</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Map&amp;lt;Long, Person&amp;gt; found = queryRunner.query(&amp;quot;select id, name, age from person&amp;quot;, h);</a>
<span class="sourceLineNo">037</span><a id="line.37"> * Person jane = found.get(1L); // jane's id is 1</a>
<span class="sourceLineNo">038</span><a id="line.38"> * String janesName = jane.getName();</a>
<span class="sourceLineNo">039</span><a id="line.39"> * Integer janesAge = jane.getAge();</a>
<span class="sourceLineNo">040</span><a id="line.40"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">041</span><a id="line.41"> *</a>
<span class="sourceLineNo">042</span><a id="line.42"> * Note that the "id" passed to BeanMapHandler can be in any case. The data type</a>
<span class="sourceLineNo">043</span><a id="line.43"> * returned for id is dependent upon how your JDBC driver converts SQL column</a>
<span class="sourceLineNo">044</span><a id="line.44"> * types from the Person table into Java types. The "name" and "age" columns are</a>
<span class="sourceLineNo">045</span><a id="line.45"> * converted according to their property descriptors by DbUtils.</a>
<span class="sourceLineNo">046</span><a id="line.46"> * &amp;lt;/p&amp;gt;</a>
<span class="sourceLineNo">047</span><a id="line.47"> * &lt;p&gt;</a>
<span class="sourceLineNo">048</span><a id="line.48"> * This class is thread safe.</a>
<span class="sourceLineNo">049</span><a id="line.49"> * &amp;lt;/p&amp;gt;</a>
<span class="sourceLineNo">050</span><a id="line.50"> *</a>
<span class="sourceLineNo">051</span><a id="line.51"> * @param &lt;K&gt;</a>
<span class="sourceLineNo">052</span><a id="line.52"> *            the type of keys maintained by the returned map</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @param &lt;V&gt;</a>
<span class="sourceLineNo">054</span><a id="line.54"> *            the type of the bean</a>
<span class="sourceLineNo">055</span><a id="line.55"> * @see org.apache.commons.dbutils.ResultSetHandler</a>
<span class="sourceLineNo">056</span><a id="line.56"> * @since DbUtils 1.5</a>
<span class="sourceLineNo">057</span><a id="line.57"> */</a>
<span class="sourceLineNo">058</span><a id="line.58">public class BeanMapHandler&lt;K, V&gt; extends AbstractKeyedHandler&lt;K, V&gt; {</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60">    /**</a>
<span class="sourceLineNo">061</span><a id="line.61">     * The Class of beans produced by this handler.</a>
<span class="sourceLineNo">062</span><a id="line.62">     */</a>
<span class="sourceLineNo">063</span><a id="line.63">    private final Class&lt;V&gt; type;</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65">    /**</a>
<span class="sourceLineNo">066</span><a id="line.66">     * The RowProcessor implementation to use when converting rows into Objects.</a>
<span class="sourceLineNo">067</span><a id="line.67">     */</a>
<span class="sourceLineNo">068</span><a id="line.68">    private final RowProcessor convert;</a>
<span class="sourceLineNo">069</span><a id="line.69"></a>
<span class="sourceLineNo">070</span><a id="line.70">    /**</a>
<span class="sourceLineNo">071</span><a id="line.71">     * The column index to retrieve key values from. Defaults to 1.</a>
<span class="sourceLineNo">072</span><a id="line.72">     */</a>
<span class="sourceLineNo">073</span><a id="line.73">    private final int columnIndex;</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75">    /**</a>
<span class="sourceLineNo">076</span><a id="line.76">     * The column name to retrieve key values from. Either columnName or</a>
<span class="sourceLineNo">077</span><a id="line.77">     * columnIndex will be used but never both.</a>
<span class="sourceLineNo">078</span><a id="line.78">     */</a>
<span class="sourceLineNo">079</span><a id="line.79">    private final String columnName;</a>
<span class="sourceLineNo">080</span><a id="line.80"></a>
<span class="sourceLineNo">081</span><a id="line.81">    /**</a>
<span class="sourceLineNo">082</span><a id="line.82">     * Creates a new instance of BeanMapHandler. The value of the first column</a>
<span class="sourceLineNo">083</span><a id="line.83">     * of each row will be a key in the Map.</a>
<span class="sourceLineNo">084</span><a id="line.84">     *</a>
<span class="sourceLineNo">085</span><a id="line.85">     * @param type</a>
<span class="sourceLineNo">086</span><a id="line.86">     *            The Class that objects returned from {@code createRow()}</a>
<span class="sourceLineNo">087</span><a id="line.87">     *            are created from.</a>
<span class="sourceLineNo">088</span><a id="line.88">     */</a>
<span class="sourceLineNo">089</span><a id="line.89">    public BeanMapHandler(final Class&lt;V&gt; type) {</a>
<span class="sourceLineNo">090</span><a id="line.90">        this(type, ArrayHandler.ROW_PROCESSOR, 1, null);</a>
<span class="sourceLineNo">091</span><a id="line.91">    }</a>
<span class="sourceLineNo">092</span><a id="line.92"></a>
<span class="sourceLineNo">093</span><a id="line.93">    /**</a>
<span class="sourceLineNo">094</span><a id="line.94">     * Creates a new instance of BeanMapHandler. The value of the first column</a>
<span class="sourceLineNo">095</span><a id="line.95">     * of each row will be a key in the Map.</a>
<span class="sourceLineNo">096</span><a id="line.96">     *</a>
<span class="sourceLineNo">097</span><a id="line.97">     * @param type</a>
<span class="sourceLineNo">098</span><a id="line.98">     *            The Class that objects returned from {@code createRow()}</a>
<span class="sourceLineNo">099</span><a id="line.99">     *            are created from.</a>
<span class="sourceLineNo">100</span><a id="line.100">     * @param convert</a>
<span class="sourceLineNo">101</span><a id="line.101">     *            The {@code RowProcessor} implementation to use when</a>
<span class="sourceLineNo">102</span><a id="line.102">     *            converting rows into Beans</a>
<span class="sourceLineNo">103</span><a id="line.103">     */</a>
<span class="sourceLineNo">104</span><a id="line.104">    public BeanMapHandler(final Class&lt;V&gt; type, final RowProcessor convert) {</a>
<span class="sourceLineNo">105</span><a id="line.105">        this(type, convert, 1, null);</a>
<span class="sourceLineNo">106</span><a id="line.106">    }</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108">    /**</a>
<span class="sourceLineNo">109</span><a id="line.109">     * Creates a new instance of BeanMapHandler.</a>
<span class="sourceLineNo">110</span><a id="line.110">     *</a>
<span class="sourceLineNo">111</span><a id="line.111">     * @param type</a>
<span class="sourceLineNo">112</span><a id="line.112">     *            The Class that objects returned from {@code createRow()}</a>
<span class="sourceLineNo">113</span><a id="line.113">     *            are created from.</a>
<span class="sourceLineNo">114</span><a id="line.114">     * @param columnIndex</a>
<span class="sourceLineNo">115</span><a id="line.115">     *            The values to use as keys in the Map are retrieved from the</a>
<span class="sourceLineNo">116</span><a id="line.116">     *            column at this index.</a>
<span class="sourceLineNo">117</span><a id="line.117">     */</a>
<span class="sourceLineNo">118</span><a id="line.118">    public BeanMapHandler(final Class&lt;V&gt; type, final int columnIndex) {</a>
<span class="sourceLineNo">119</span><a id="line.119">        this(type, ArrayHandler.ROW_PROCESSOR, columnIndex, null);</a>
<span class="sourceLineNo">120</span><a id="line.120">    }</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122">    /**</a>
<span class="sourceLineNo">123</span><a id="line.123">     * Creates a new instance of BeanMapHandler.</a>
<span class="sourceLineNo">124</span><a id="line.124">     *</a>
<span class="sourceLineNo">125</span><a id="line.125">     * @param type</a>
<span class="sourceLineNo">126</span><a id="line.126">     *            The Class that objects returned from {@code createRow()}</a>
<span class="sourceLineNo">127</span><a id="line.127">     *            are created from.</a>
<span class="sourceLineNo">128</span><a id="line.128">     * @param columnName</a>
<span class="sourceLineNo">129</span><a id="line.129">     *            The values to use as keys in the Map are retrieved from the</a>
<span class="sourceLineNo">130</span><a id="line.130">     *            column with this name.</a>
<span class="sourceLineNo">131</span><a id="line.131">     */</a>
<span class="sourceLineNo">132</span><a id="line.132">    public BeanMapHandler(final Class&lt;V&gt; type, final String columnName) {</a>
<span class="sourceLineNo">133</span><a id="line.133">        this(type, ArrayHandler.ROW_PROCESSOR, 1, columnName);</a>
<span class="sourceLineNo">134</span><a id="line.134">    }</a>
<span class="sourceLineNo">135</span><a id="line.135"></a>
<span class="sourceLineNo">136</span><a id="line.136">    /**</a>
<span class="sourceLineNo">137</span><a id="line.137">     * Private Helper</a>
<span class="sourceLineNo">138</span><a id="line.138">     *</a>
<span class="sourceLineNo">139</span><a id="line.139">     * @param convert</a>
<span class="sourceLineNo">140</span><a id="line.140">     *            The {@code RowProcessor} implementation to use when</a>
<span class="sourceLineNo">141</span><a id="line.141">     *            converting rows into Beans</a>
<span class="sourceLineNo">142</span><a id="line.142">     * @param columnIndex</a>
<span class="sourceLineNo">143</span><a id="line.143">     *            The values to use as keys in the Map are retrieved from the</a>
<span class="sourceLineNo">144</span><a id="line.144">     *            column at this index.</a>
<span class="sourceLineNo">145</span><a id="line.145">     * @param columnName</a>
<span class="sourceLineNo">146</span><a id="line.146">     *            The values to use as keys in the Map are retrieved from the</a>
<span class="sourceLineNo">147</span><a id="line.147">     *            column with this name.</a>
<span class="sourceLineNo">148</span><a id="line.148">     */</a>
<span class="sourceLineNo">149</span><a id="line.149">    private BeanMapHandler(final Class&lt;V&gt; type, final RowProcessor convert,</a>
<span class="sourceLineNo">150</span><a id="line.150">            final int columnIndex, final String columnName) {</a>
<span class="sourceLineNo">151</span><a id="line.151">        super();</a>
<span class="sourceLineNo">152</span><a id="line.152">        this.type = type;</a>
<span class="sourceLineNo">153</span><a id="line.153">        this.convert = convert;</a>
<span class="sourceLineNo">154</span><a id="line.154">        this.columnIndex = columnIndex;</a>
<span class="sourceLineNo">155</span><a id="line.155">        this.columnName = columnName;</a>
<span class="sourceLineNo">156</span><a id="line.156">    }</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158">    /**</a>
<span class="sourceLineNo">159</span><a id="line.159">     * This factory method is called by {@code handle()} to retrieve the</a>
<span class="sourceLineNo">160</span><a id="line.160">     * key value from the current {@code ResultSet} row.</a>
<span class="sourceLineNo">161</span><a id="line.161">     * @param rs ResultSet to create a key from</a>
<span class="sourceLineNo">162</span><a id="line.162">     *</a>
<span class="sourceLineNo">163</span><a id="line.163">     * @return K from the configured key column name/index</a>
<span class="sourceLineNo">164</span><a id="line.164">     *</a>
<span class="sourceLineNo">165</span><a id="line.165">     * @throws SQLException if a database access error occurs</a>
<span class="sourceLineNo">166</span><a id="line.166">     * @throws ClassCastException if the class datatype does not match the column type</a>
<span class="sourceLineNo">167</span><a id="line.167">     *</a>
<span class="sourceLineNo">168</span><a id="line.168">     * @see org.apache.commons.dbutils.handlers.AbstractKeyedHandler#createKey(ResultSet)</a>
<span class="sourceLineNo">169</span><a id="line.169">     */</a>
<span class="sourceLineNo">170</span><a id="line.170">    // We assume that the user has picked the correct type to match the column</a>
<span class="sourceLineNo">171</span><a id="line.171">    // so getObject will return the appropriate type and the cast will succeed.</a>
<span class="sourceLineNo">172</span><a id="line.172">    @SuppressWarnings("unchecked")</a>
<span class="sourceLineNo">173</span><a id="line.173">    @Override</a>
<span class="sourceLineNo">174</span><a id="line.174">    protected K createKey(final ResultSet rs) throws SQLException {</a>
<span class="sourceLineNo">175</span><a id="line.175">        return (columnName == null) ?</a>
<span class="sourceLineNo">176</span><a id="line.176">               (K) rs.getObject(columnIndex) :</a>
<span class="sourceLineNo">177</span><a id="line.177">               (K) rs.getObject(columnName);</a>
<span class="sourceLineNo">178</span><a id="line.178">    }</a>
<span class="sourceLineNo">179</span><a id="line.179"></a>
<span class="sourceLineNo">180</span><a id="line.180">    @Override</a>
<span class="sourceLineNo">181</span><a id="line.181">    protected V createRow(final ResultSet rs) throws SQLException {</a>
<span class="sourceLineNo">182</span><a id="line.182">        return this.convert.toBean(rs, type);</a>
<span class="sourceLineNo">183</span><a id="line.183">    }</a>
<span class="sourceLineNo">184</span><a id="line.184"></a>
<span class="sourceLineNo">185</span><a id="line.185">}</a>




























































</pre>
</div>
</main>
</body>
</html>
